GET api/buildings/selector?entityId={entityId}&active={active}&buildingTypes[0]={buildingTypes[0]}&buildingTypes[1]={buildingTypes[1]}

Get buildings for the building selector Returns minimum information

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityId

integer

None.

active

boolean

None.

buildingTypes

Collection of integer

None.

Body Parameters

None.

Response Information

Resource Description

BuildingSelectorViewModel

BuildingSelectorViewModel
NameDescriptionTypeAdditional information
Id

Building Id

integer

None.

Name

Building Name

string

None.

ReadableBuildingId

Readable Building Id

string

None.

BuildingTypeId

Building type

integer

None.

Active

Building current state

integer

None.

AreRecurringChargesRounded

Building are rounded charges

boolean

None.

SupportConsolidatedBilling

Building Support Consolidated Billing

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "readableBuildingId": "sample string 3",
  "buildingTypeId": 4,
  "active": 5,
  "areRecurringChargesRounded": true,
  "supportConsolidatedBilling": true
}

application/xml, text/xml

Sample:
<BuildingSelectorViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Active>5</Active>
  <AreRecurringChargesRounded>true</AreRecurringChargesRounded>
  <BuildingTypeId>4</BuildingTypeId>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <ReadableBuildingId>sample string 3</ReadableBuildingId>
  <SupportConsolidatedBilling>true</SupportConsolidatedBilling>
</BuildingSelectorViewModel>